Playback for property target interpolation timeline. More...

#include <kanzi/ui/node_component/animation/property_target_interpolation_timeline_playback.hpp>

Inheritance diagram for kanzi::PropertyTargetInterpolationTimelinePlayback:

Public Member Functions
	~PropertyTargetInterpolationTimelinePlayback () override
	Destructor.

Public Member Functions inherited from kanzi::TimelinePlayback
chrono::milliseconds	getGlobalTime () const
	Gets current global time of TimelinePlayback.

chrono::milliseconds	getProgressTime () const
	Gets current progress time of TimelinePlayback.

State	getState () const
	Gets current state of playback.

bool	isApplied () const
	Indicates whether TimelinePlayback is applied.

void	onParentAppliedStateChanged ()
	Notifies TimelinePlayback whether the applied state of its parent playback has changed.

void	onParentCompleted ()
	Notifies TimelinePlayback whether its parent playback has completed.

void	setCompleteCallback (CompleteCallback callback)
	Sets complete callback.

void	setGlobalTime (chrono::milliseconds time)
	Sets global time of playback and calculates new global time from it as well as other parameters such as current iteration index, etc.

void	setParent (TimelinePlayback *playback)
	Sets parent playback.

void	stop ()
	Stops playback.

void	tick (chrono::milliseconds deltaTime)
	Advances TimelinePlayback's global time by delta time and calculates new progress time from it as well as other parameters such as current iteration index, etc.

	TimelinePlayback (Domain *domain, TimelineSharedPtr timeline)
	Constructor.

	~TimelinePlayback () override
	Destructor.

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object.

void	applyObjectStyles ()
	Apply all styles for an object node.

Domain *	getDomain () const
	Returns the domain the object belongs to.

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object.

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain.

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object.

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object.

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object.

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object.

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it.

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers.

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container.

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object.

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object.

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers.

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type.

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers.

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property.

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property.

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value.

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications.

	PropertyObject ()

void	removeKzbProperties ()
	Remove all KZB properties.

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set.

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property.

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type.

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

virtual	~PropertyObject ()

Static Public Member Functions
static PropertyTargetInterpolationTimelinePlaybackSharedPtr	create (PropertyTargetInterpolationTimelineSharedPtr propertyAnimationTimeline, ObjectSharedPtr object)
	Creates playback.

static PropertyTargetInterpolationTimelinePlaybackSharedPtr	create (PropertyTargetInterpolationTimelineSharedPtr propertyAnimationTimeline, TimelinePlaybackContext &context)
	Creates playback.

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Protected Member Functions
void	forgetModifier ()
	Forgets modifier if it is removed from property from outside of playback (i.e. when target property is deleted).

void	installModifier ()
	Installs modifier to property the value of which should be interpolated.

template<typename T >
void	installModifier ()
	Installs interpolation modifier to property of specific type.

template<typename T >
void	modifyPropertyValue (T &currentValue, PropertyNotificationReason reason)
	Modifies property value.

template<typename T >
void	modifyValue (T &currentValue)
	Modifies value.

void	onAppliedStateChangedOverride () override
	TimelinePlayback::onAppliedStateChangedOverride() implementation.

void	onProgressTimeResetOverride () override
	TimelinePlayback::onProgressTimeResetOverride() implementation.

	PropertyTargetInterpolationTimelinePlayback (PropertyTargetInterpolationTimelineSharedPtr propertyAnimationTimeline, ObjectSharedPtr object)
	Constructor.

void	tickOverride (chrono::milliseconds deltaTime) override
	TimelinePlayback::tickOverride() implementation.

void	uninstallModifier ()
	Uninstalls interpolation modifier from property.

template<typename T >
void	uninstallModifier ()
	Uninstalls interpolation modifier from property of specific type.

Protected Member Functions inherited from kanzi::TimelinePlayback
void	notifyPlaybackCompleted ()
	Calls completion callback if it is available.

virtual void	onPlaybackCompletedOverride ()
	TimelinePlayback calls this function after it has become complete.

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value.

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source.

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage.

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor.

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor.

virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage.

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage.

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source.

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

Static Protected Member Functions
template<typename T >
static void	modifierCallback (PropertyObject &object, T &currentValue, PropertyNotificationReason reason, void *userData)
	Property modifier callback where interpolation happens.

Additional Inherited Members
Public Types inherited from kanzi::TimelinePlayback
typedef function< void(TimelinePlayback &)	CompleteCallback)
	Callback for complete timeline.

enum	State { StateNotStarted , StateOngoing , StateCompleted , StateStopped }
	Status of the playback. More...

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container.

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Detailed Description

Playback for property target interpolation timeline.

Note that setting time to this playback or advancing it backwards (calling its tick function with negative delta time) is not supported: negative delta time will be clamped to zero.

Constructor & Destructor Documentation

◆ ~PropertyTargetInterpolationTimelinePlayback()

kanzi::PropertyTargetInterpolationTimelinePlayback::~PropertyTargetInterpolationTimelinePlayback ( )

override

Destructor.

◆ PropertyTargetInterpolationTimelinePlayback()

kanzi::PropertyTargetInterpolationTimelinePlayback::PropertyTargetInterpolationTimelinePlayback	(	PropertyTargetInterpolationTimelineSharedPtr	propertyAnimationTimeline,
		ObjectSharedPtr	object )

explicitprotected

Constructor.

Parameters

propertyAnimationTimeline	Timeline to play.
object	Object the property of which should be interpolated.

Member Function Documentation

◆ create() [1/2]

static PropertyTargetInterpolationTimelinePlaybackSharedPtr kanzi::PropertyTargetInterpolationTimelinePlayback::create	(	PropertyTargetInterpolationTimelineSharedPtr	propertyAnimationTimeline,
		ObjectSharedPtr	object )

static

Creates playback.

Parameters

propertyAnimationTimeline	Timeline to play.
object	Object the property of which should be interpolated.

Returns: Playback.

◆ create() [2/2]

static PropertyTargetInterpolationTimelinePlaybackSharedPtr kanzi::PropertyTargetInterpolationTimelinePlayback::create	(	PropertyTargetInterpolationTimelineSharedPtr	propertyAnimationTimeline,
		TimelinePlaybackContext &	context )

static

Creates playback.

Parameters

propertyAnimationTimeline	Timeline to play.
context	Context for resolving object the property of which should be interpolated.

Returns: Playback.

◆ tickOverride()

void kanzi::PropertyTargetInterpolationTimelinePlayback::tickOverride ( chrono::milliseconds deltaTime )

overrideprotectedvirtual

TimelinePlayback::tickOverride() implementation.

Implements kanzi::TimelinePlayback.

◆ modifierCallback()

template<typename T >

static void kanzi::PropertyTargetInterpolationTimelinePlayback::modifierCallback	(	PropertyObject &	object,
		T &	currentValue,
		PropertyNotificationReason	reason,
		void *	userData )

staticprotected

Property modifier callback where interpolation happens.

Parameters

object	Object the property of which is modified.
currentValue	Reference to property value to modify.
reason	Reason for which the modification is requested.
userData	User data.

◆ modifyPropertyValue()

template<typename T >

void kanzi::PropertyTargetInterpolationTimelinePlayback::modifyPropertyValue	(	T &	currentValue,
		PropertyNotificationReason	reason )

protected

Modifies property value.

Parameters

currentValue	Reference to value to modify.
reason	Reason for which the modification is requested.

◆ modifyValue()

template<typename T >

void kanzi::PropertyTargetInterpolationTimelinePlayback::modifyValue ( T & currentValue )

protected

Modifies value.

Parameters

currentValue Reference to value to modify.

◆ installModifier() [1/2]

void kanzi::PropertyTargetInterpolationTimelinePlayback::installModifier ( )

protected

Installs modifier to property the value of which should be interpolated.

◆ installModifier() [2/2]

template<typename T >

void kanzi::PropertyTargetInterpolationTimelinePlayback::installModifier ( )

protected

Installs interpolation modifier to property of specific type.

◆ uninstallModifier() [1/2]

void kanzi::PropertyTargetInterpolationTimelinePlayback::uninstallModifier ( )

protected

Uninstalls interpolation modifier from property.

◆ uninstallModifier() [2/2]

template<typename T >

void kanzi::PropertyTargetInterpolationTimelinePlayback::uninstallModifier ( )

protected

Uninstalls interpolation modifier from property of specific type.

◆ forgetModifier()

void kanzi::PropertyTargetInterpolationTimelinePlayback::forgetModifier ( )

protected

Forgets modifier if it is removed from property from outside of playback (i.e. when target property is deleted).

◆ onProgressTimeResetOverride()

void kanzi::PropertyTargetInterpolationTimelinePlayback::onProgressTimeResetOverride ( )

overrideprotectedvirtual

TimelinePlayback::onProgressTimeResetOverride() implementation.

Reimplemented from kanzi::TimelinePlayback.

◆ onAppliedStateChangedOverride()

void kanzi::PropertyTargetInterpolationTimelinePlayback::onAppliedStateChangedOverride ( )

overrideprotectedvirtual

TimelinePlayback::onAppliedStateChangedOverride() implementation.

Reimplemented from kanzi::TimelinePlayback.

The documentation for this class was generated from the following file:

kanzi/ui/node_component/animation/property_target_interpolation_timeline_playback.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~PropertyTargetInterpolationTimelinePlayback()

◆ PropertyTargetInterpolationTimelinePlayback()

Member Function Documentation

◆ create() [1/2]

◆ create() [2/2]

◆ tickOverride()

◆ modifierCallback()

◆ modifyPropertyValue()

◆ modifyValue()

◆ installModifier() [1/2]

◆ installModifier() [2/2]

◆ uninstallModifier() [1/2]

◆ uninstallModifier() [2/2]

◆ forgetModifier()

◆ onProgressTimeResetOverride()

◆ onAppliedStateChangedOverride()